PATHCONF

Section: System Calls (2)
Index Return to Main Contents

BSD mandoc
BSD 4

NAME

pathconf fpathconf - get configurable pathname variables

SYNOPSIS

Fd #include <unistd.h> Ft long Fn pathconf const char *path int name Ft long Fn fpathconf int fd int name

DESCRIPTION

The Fn pathconf and Fn fpathconf functions provides a method for applications to determine the current value of a configurable system limit or option variable associated with a pathname or file descriptor.

For pathconf the Fa path argument is the name of a file or directory. For fpathconf the Fa fd argument is an open file descriptor. The Fa name argument specifies the system variable to be queried. Symbolic constants for each name value are found in the include file <unistd.h>

The available values are as follows:

_PC_LINK_MAX: The maximum file link count.
_PC_MAX_CANON: The maximum number of bytes in terminal canonical input line.
_PC_MAX_INPUT: The minimum maximum number of bytes for which space is available in a terminal input queue.
_PC_NAME_MAX: The maximum number of bytes in a file name.
_PC_PATH_MAX: The maximum number of bytes in a pathname.
_PC_PIPE_BUF: The maximum number of bytes which will be written atomically to a pipe.
_PC_CHOWN_RESTRICTED: Return 1 if appropriate privileges are required for the chown(2) system call, otherwise 0.
_PC_NO_TRUNC: Return 1 if file names longer than KERN_NAME_MAX are truncated.
_PC_VDISABLE: Returns the terminal character disabling value.

RETURN VALUES

If the call to pathconf or fpathconf is not successful, -1 is returned and errno is set appropriately. Otherwise, if the variable is associated with functionality that does not have a limit in the system, -1 is returned and errno is not modified. Otherwise, the current variable value is returned.

ERRORS

If any of the following conditions occur, the pathconf and fpathconf functions shall return -1 and set errno to the corresponding value.

Bq Er EINVAL: The value of the Fa name argument is invalid.
Bq Er EINVAL: The implementation does not support an association of the variable name with the associated file.

Fn Pathconf will fail if:

Bq Er ENOTDIR: A component of the path prefix is not a directory.
Bq Er ENAMETOOLONG: A component of a pathname exceeded 255 characters, or an entire path name exceeded 1023 characters.
Bq Er ENOENT: The named file does not exist.
Bq Er EACCES: Search permission is denied for a component of the path prefix.
Bq Er ELOOP: Too many symbolic links were encountered in translating the pathname.
Bq Er EIO: An I/O error occurred while reading from or writing to the file system.

Bq Er EBADF: Fa fd is not a valid open file descriptor.
Bq Er EIO: An I/O error occurred while reading from or writing to the file system.

HISTORY

The pathconf and fpathconf functions first appeared in 4.4BSD.

This document was created by man2html, using the manual pages.
Time: 16:28:59 GMT, April 18, 2022